SGI Freeware 2002 November

home *** CD-ROM | disk | FTP | other *** search

/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 1.iso / dist / fw_enscript.idb / usr / freeware / catman / u_man / cat1 / enscript.Z / enscript

Wrap

Text File | 2002-04-08 | 57.3 KB | 1,379 lines

ENSCRIPT(1) ENSCRIPT ENSCRIPT(1) NNAAMMEE enscript - convert text files to PostScript, HTML, RTF, ANSI, and overstrikes SSYYNNOOPPSSIISS eennssccrriipptt [--112233445566778899BBccggGGhhjjkkKKllmmOOqqrrRRvvVVzzZZ] [--## _c_o_p_i_e_s] [--aa _p_a_g_e_s] [--AA _a_l_i_g_n] [--bb _h_e_a_d_e_r] [--CC[_s_t_a_r_t___l_i_n_e]] [--dd _p_r_i_n_t_e_r] [--DD _k_e_y[::_v_a_l_u_e]] [--ee[_c_h_a_r]] [--EE[_l_a_n_g]] [--ff _f_o_n_t] [--FF _h_e_a_d_e_r___f_o_n_t] [--HH[_n_u_m]] [--ii _i_n_d_e_n_t] [--II _f_i_l_t_e_r] [--JJ _t_i_t_l_e] [--LL _l_i_n_e_s___p_e_r___p_a_g_e] [--MM _m_e_d_i_a] [--nn _c_o_p_i_e_s] [--NN _n_e_w_ _l_i_n_e] [--oo _o_u_t_p_u_t_f_i_l_e] [--oo --] [--pp _o_u_t_p_u_t_f_i_l_e] [--pp --] [--PP _p_r_i_n_t_e_r] [--ss _b_a_s_e_l_i_n_e_s_k_i_p] [--SS _k_e_y[::_v_a_l_u_e]] [--tt _t_i_t_l_e] [--TT _t_a_b_s_i_z_e] [--uu[_t_e_x_t]] [--UU _n_u_m] [--ww _l_a_n_g_u_a_g_e] [--XX _e_n_c_o_d_i_n_g] [_f_i_l_e_n_a_m_e ...] DDEESSCCRRIIPPTTIIOONN EEnnssccrriipptt converts text files to PostScript or to other output languages. EEnnssccrriipptt can spool the generated output directly to a specified printer or leave it to a file. If no input files are given, eennssccrriipptt processes the standard input ssttddiinn. EEnnssccrriipptt can be extended to handle different output media and it has many options which can be used to customize the printouts. OOPPTTIIOONNSS --## _n_u_m Print _n_u_m copies of each page. --11,, --22,, --33,, --44,, --55,, --66,, --77,, --88,, --99,, ----ccoolluummnnss==_n_u_m Specify how many columns each page have. With the long option ----ccoolluummnnss==_n_u_m you can specify more than 9 columns per page. --aa _p_a_g_e_s,, ----ppaaggeess==_p_a_g_e_s Specify which pages are printed. The page speci fication _p_a_g_e_s can be given in the following for mats: _b_e_g_i_n-_e_n_d print pages from _b_e_g_i_n to _e_n_d -_e_n_d print pages from 0 to _e_n_d _b_e_g_i_n- print pages from _b_e_g_i_n to end _p_a_g_e print page _p_a_g_e odd print odd pages even print even pages --AA _a_l_i_g_n,, ----ffiillee--aalliiggnn==_a_l_i_g_n Align separate input files to even _a_l_i_g_n page count. This option is useful in two-side and 2-up printings (--file-align=2). --bb _h_e_a_d_e_r,, ----hheeaaddeerr==_h_e_a_d_e_r Use the text _h_e_a_d_e_r as a page header. The default page header is constructed from the name of the file and from its last modification time. The header string _h_e_a_d_e_r can contain the same for matting escapes which can be specified for the %%FFoorrmmaatt directives in the user defined fancy head ers. For example, the following option prints the file name, current data and page numbers: eennssccrriipptt ----hheeaaddeerr==''$$nn %%WW PPaaggee $$%% ooff $$=='' **..cc The header string can also contain left, center and right justified fields. The fields are sepa rated by the ''||'' character: eennssccrriipptt ----hheeaaddeerr==''$$nn||%%WW||PPaaggee $$%% ooff $$=='' **..cc now the file name is printed left justified, the date is centered to the header and the page num bers are printed right justified. --BB,, ----nnoo--hheeaaddeerr Do not print page headers. --cc,, ----ttrruunnccaattee--lliinneess Cut lines that are too long for the page. As a default, eennssccrriipptt wraps long lines to the next line so no information is lost. You can also use the ----sslliiccee option which slices long lines to separate pages. --CC[_s_t_a_r_t___l_i_n_e],, ----lliinnee--nnuummbbeerrss[==_s_t_a_r_t___l_i_n_e] Precede each line with its line number. The optional argument _s_t_a_r_t___l_i_n_e specifies the number of the first line in the input. The number of the first line defaults to 1. --dd _n_a_m_e Spool output to the printer _n_a_m_e. --DD _k_e_y[::_v_a_l_u_e],, ----sseettppaaggeeddeevviiccee==_k_e_y[::_v_a_l_u_e] Pass a page device definition to the generated PostScript output. If no value is given, the key _k_e_y is removed from the definitions. For example, the command eennssccrriipptt --DDDDuupplleexx::ttrruuee ffoooo..ttxxtt prints file foo.txt in duplex (two side) mode. Page device operators are implementation dependant but they are standardized. See section PPAAGGEE DDEEVVIICCEE OOPPTTIIOONNSS for the details. --ee[_c_h_a_r],, ----eessccaappeess[==_c_h_a_r] Enable special escapes interpretation (see section SSPPEECCIIAALL EESSCCAAPPEESS). If the argument _c_h_a_r is given, it changes the escape character to _c_h_a_r. The default escape character is 0. --EE[_l_a_n_g],, ----hhiigghhlliigghhtt[==_l_a_n_g] Highlight source code by creating a special input filter with the ssttaatteess program. The optional argument _l_a_n_g specifies the language to highlight. As a default the ssttaatteess makes an educated guess. You can print a short description of the supported highlighting languages and file formats with the command: eennssccrriipptt ----hheellpp--hhiigghhlliigghhtt The highlighting rules are defined in the `@DATADIR@/enscript/st/*.st' files which can be edited to create highlighting definitions for new languages. NNoottee!! You can not use your own input filters with this option. --ff _n_a_m_e,, ----ffoonntt==_n_a_m_e Select a font that is used for the body text. The default body font is CCoouurriieerr1100, unless multicolumn landscape printing mode is selected, in which case the default font is CCoouurriieerr77. The font specification _n_a_m_e contains two parts: the name of the font and its size in PostScript points. For example, "TTiimmeess--RRoommaann1122" selects the "Times-Roman" font with size 12pt. The font specification _n_a_m_e can also be given in format `_n_a_m_e@_p_t_s_i_z_e', where the name of the font and its point size are separated by a `@' charac ter. This allows eennssccrriipptt to use fonts which con tain digit characters in their names. The font point size can also be given in the for mat _w_i_d_t_h/_h_e_i_g_h_t where the _w_i_d_t_h and the _h_e_i_g_h_t specify the size of the font in x- and y-direc tions. For example, "TTiimmeess--RRoommaann@@1100//1122" selects a 10 points wide and 12 points high "Times-Roman" font. You can also give the font sizes as decimal num bers. For example, "TTiimmeess--RRoommaann1100..22" selects a 10.2pt "Times-Roman" font. --FF _n_a_m_e,, ----hheeaaddeerr--ffoonntt==_n_a_m_e Select a font for the header texts. --gg,, ----pprriinntt--aannyywwaayy Print a file even if it contains binary data. The option is implemented only for compatibility pur poses. EEnnssccrriipptt prints binary files anyway regardless of the option. --GG,, ----ffaannccyy--hheeaaddeerr[==_n_a_m_e] Print a fancy page header _n_a_m_e to the top of each page. The option --GG specifies the default fancy header. See section CCOONNFFIIGGUURRAATTIIOONN FFIILLEESS to see how the default fancy header can be changed. --hh,, ----nnoo--jjoobb--hheeaaddeerr Suppress printing of the job header page. --HH[_n_u_m],, ----hhiigghhlliigghhtt--bbaarrss[==_n_u_m] Specify how high the highlight bars are in lines. If the _n_u_m is not given, the default value 2 is used. As a default, no highlight bars are printed. --ii _n_u_m,, ----iinnddeenntt==_n_u_m Indent every line _n_u_m characters. The indentation can also be specified in other units by appending an unit specifier after the number. The possible unit specifiers and the corresponding units are: cc centimeters ii inches ll characters (default) pp PostScript points --II _f_i_l_t_e_r,, ----ffiilltteerr==_f_i_l_t_e_r Read all input files through an input filter _f_i_l_ _t_e_r. The input filter can be a single command or a command pipeline. The filter can refer to the name of the input file with the escape `%%ss'. The name of the standard input can be changed with the option `----ffiilltteerr--ssttddiinn'. For example, the following command prints the file `foo.c' by using only upper-case characters: eennssccrriipptt ----ffiilltteerr==""ccaatt %%ss || ttrr ''aa--zz'' ''AA--ZZ''"" ffoooo..cc The following command highlights changes which are made to files since the last checkout: eennssccrriipptt ----ffiilltteerr==""rrccssddiiffff %%ss || ddiiffffpppp %%ss"" --ee **..cc To include the string "%s" to the filter command, you must write it as "%%s". --jj,, ----bboorrddeerrss Print borders around columns. --JJ _t_i_t_l_e An alias for the option --tt, ----ttiittllee. --kk,, ----ppaaggee--pprreeffeeeedd Enable page prefeed. --KK,, ----nnoo--ppaaggee--pprreeffeeeedd Disable page prefeed (default). --ll,, ----lliinneepprriinntteerr Emulate lineprinter. This option is a shortcut for the options ----lliinneess--ppeerr--ppaaggee==6666, and ----nnoo--hheeaaddeerr. --LL _n_u_m,, ----lliinneess--ppeerr--ppaaggee==_n_u_m Print only _n_u_m lines for each page. As a default, the number of lines per page is computed from the height of the page and from the size of the font. --mm,, ----mmaaiill Send a mail notification to user after the print job has been completed. --MM _n_a_m_e,, ----mmeeddiiaa==_n_a_m_e Select an output media _n_a_m_e. EEnnssccrriipptt's default output media is @@mmeeddiiaa@@. --nn _n_u_m,, ----ccooppiieess==_n_u_m Print _n_u_m copies of each page. --NN _n_l,, ----nneewwlliinnee==_n_l Select the _n_e_w_l_i_n_e character. The possible values for _n_l are: nn (unix newline, 0xa hex) and rr (mac newline, 0xd hex). --oo _f_i_l_e An alias for the option --pp, ----oouuttppuutt. --OO,, ----mmiissssiinngg--cchhaarraacctteerrss Print a listing of character codes which couldn't be printed. --pp _f_i_l_e,, ----oouuttppuutt==_f_i_l_e Leave the output to file _f_i_l_e. If the _f_i_l_e is `-', enscript sends the output to the standard output ssttddoouutt. --PP _n_a_m_e,, ----pprriinntteerr==_n_a_m_e Spool the output to the printer _n_a_m_e. --qq,, ----qquuiieett,, ----ssiilleenntt Make eennssccrriipptt really quiet. Only fatal error mes sages are printed to _s_t_d_e_r_r. --rr,, ----llaannddssccaappee Print in the landscape mode; rotate page 90 degrees. --RR,, ----ppoorrttrraaiitt Print in the portrait mode (default). --ss _n_u_m,, ----bbaasseelliinneesskkiipp==_n_u_m Specify the baseline skip in PostScript points. The number _n_u_m can be given as a decimal number. When eennssccrriipptt moves from line to line, the current point _y coordinate is moved (_f_o_n_t _p_o_i_n_t _s_i_z_e _+ _b_a_s_e_l_i_n_e_s_k_i_p) points down. The default baseline skip is 1. --SS _k_e_y[::_v_a_l_u_e],, ----ssttaattuussddiicctt==_k_e_y[::_v_a_l_u_e] Pass a statusdict definition to the generated PostScript output. If no value is given, the key _k_e_y is removed from the definitions. The statusdict operators are implementation depen dant; see the printer's documentation for the details. For example, the command eennssccrriipptt --SSsseettppaappeerrttrraayy::11 ffoooo..ttxxtt prints the file _f_o_o_._t_x_t by using paper from the paper tray 1 (assuming that the printer supports paper tray selection). --tt _t_i_t_l_e,, ----ttiittllee==_t_i_t_l_e Set banner page's job title to _t_i_t_l_e. The option sets also the name of the input file ssttddiinn. --TT _n_u_m,, ----ttaabbssiizzee==_n_u_m Set the tabulator size to _n_u_m characters. The default is 8. --uu[_t_e_x_t],, ----uunnddeerrllaayy[==_t_e_x_t] Print the string _t_e_x_t under every page. The properties of the text can be changed with the options ----uull--aannggllee, ----uull--ffoonntt, ----uull--ggrraayy, ----uull--ppoossiittiioonn, and ----uull--ssttyyllee. If no _t_e_x_t is given, the underlay is not printed. This can be used to remove an underlay text that was specified with the `UUnnddeerrllaayy' configuration file option. --UU _n_u_m,, ----nnuupp==_n_u_m Print _n_u_m logical pages on each output page (N-up printing). The values _n_u_m must be a power of 2. --vv,, ----vveerrbboossee[==_l_e_v_e_l] Tell what eennssccrriipptt is doing. --VV,, ----vveerrssiioonn Print eennssccrriipptt version information and exit. --ww [_l_a_n_g],, ----llaanngguuaaggee[==_l_a_n_g] Generate output for the language _l_a_n_g. The possi ble values for _l_a_n_g are: PPoossttSSccrriipptt generate PostScript (default) hhttmmll generate HTML oovveerrssttrriikkee generate overstrikes (line printers, less) rrttff generate RTF (Rich Text Format) aannssii generate ANSI terminal control codes --XX _n_a_m_e,, ----eennccooddiinngg==_n_a_m_e Use the input encoding _n_a_m_e. Currently eennssccrriipptt supports the following encodings: 8888559911,, llaattiinn11 ISO-8859-1 (ISO Latin1) (eennssccrriipptt's default encoding). 8888559922,, llaattiinn22 ISO-8859-2 (ISO Latin2) 8888559933,, llaattiinn33 ISO-8859-3 (ISO Latin3) 8888559944,, llaattiinn44 ISO-8859-4 (ISO Latin4) 8888559955,, ccyyrriilllliicc ISO-8859-5 (ISO Cyrillic) 8888559977,, ggrreeeekk ISO-8859-7 (ISO Greek) 8888559999,, llaattiinn55 ISO-8859-9 (ISO Latin5) 888855991100,, llaattiinn66 ISO-8859-10 (ISO Latin6) aasscciiii 7-bit ascii aasscciiiiffiissee,, aasscciiiiffii,, aasscciiiissee 7-bit ascii with some scandinavian (Fin land, Sweden) extensions aasscciiiiddkknnoo,, aasscciiiiddkk,, aasscciiiinnoo 7-bit ascii with some scandinavian (Den mark, Norway) extensions iibbmmppcc,, ppcc,, ddooss IBM PC charset mmaacc Mac charset vvmmss VMS multinational charset hhpp88 HP Roman-8 charset kkooii88 Adobe Standard Cyrillic Font KOI8 charset ppss,, PPSS PostScript font's default encoding ppssllaattiinn11,, IISSOOLLaattiinn11EEnnccooddiinngg PostScript interpreter's `ISOLatin1Encod ing' --zz,, ----nnoo--ffoorrmmffeeeedd Turn off the form feed character interpretation. The form feed characters are interpreted as they were newline characters. --ZZ,, ----ppaassss--tthhrroouugghh Pass through all PostScript and PCL files without any modifications. This allows that eennssccrriipptt can be used as a lp filter. The PostScript files are recognized by looking up the `%!' magic cookie from the beginning of the file. NNoottee!! EEnnssccrriipptt recognized also the Windoze damaged `^D%!' cookie. The PCL files are recognized by looking up the `^[E' or `^[%' magic cookies from the beginning of the file. ----ccoolloorr[==_b_o_o_l] Use colors in the highlighting outputs. ----ccoonnttiinnuuoouuss--lliinnee--nnuummbbeerrss Don't reset the printed page number to one on every file. If you print many files, the page numbers will continue incrementing throughout all of the files. ----ddoowwnnllooaadd--ffoonntt==_f_o_n_t_n_a_m_e Include the font description file (_._p_f_a or _._p_f_b file) of the font _f_o_n_t_n_a_m_e to the generated out put. ----eexxtteennddeedd--rreettuurrnn--vvaalluueess Enable extended return values. As a default, eennssccrriipptt returns 1 on error and 0 otherwise. The extended return values give more details about the printing operation. See the section RREETTUURRNN VVAALLUUEE for the details. ----ffiilltteerr--ssttddiinn==_n_a_m_e Specify how the ssttddiinn is shown to the input fil ter. The default value is an empty string ("") but some programs require that the ssttddiinn is called something else, usually "-". ----ffooootteerr==_f_o_o_t_e_r Use the text _f_o_o_t_e_r as a page footer. Otherwise the option works like the ----hheeaaddeerr option ----hh--ccoolluummnn--hheeiigghhtt==_h_e_i_g_h_t Set the horizontal column height to be _h_e_i_g_h_t PostScript points. The option sets the formfeed type to hhoorriizzoonnttaall--ccoolluummnnss. ----hheellpp Print a short help message and exit. ----hheellpp--hhiigghhlliigghhtt Describe all supported ----hhiigghhlliigghhtt languages and file formats. ----hhiigghhlliigghhtt--bbaarr--ggrraayy==_g_r_a_y Specify the gray level which is used in printing the highlight bars. ----lliisstt--mmeeddiiaa List the names of all known output media and exit successfully. ----mmaarrggiinnss==_l_e_f_t::_r_i_g_h_t::_t_o_p::_b_o_t_t_o_m Adjust the page marginals to be exactly _l_e_f_t, _r_i_g_h_t, _t_o_p and _b_o_t_t_o_m PostScript points. Any of the arguments can be left empty in which case the default value is used. ----mmaarrkk--wwrraappppeedd--lliinneess[==_s_t_y_l_e] Mark wrapped lines in the output with the style _s_t_y_l_e. The possible values for the _s_t_y_l_e are: nnoonnee do not mark them (default) pplluuss print a plus (+) character to the end of each wrapped line bbooxx print a black box to the end of each wrapped line aarrrrooww print a small arrow to the end of each wrapped line ----nnoonn--pprriinnttaabbllee--ffoorrmmaatt==_f_o_r_m_a_t Specify how the non-printable characters are printed. The possible values for the _f_o_r_m_a_t are: ccaarreett caret notation: `^@', `^A', `^B', ... ooccttaall octal notation: `\000', `\001', `\002', ... (default) qquueessttiioonnmmaarrkk replace non-printable characters with a question mark `?' ssppaaccee replace non-printable characters with a space ` ' ----nnuupp--ccoolluummnnwwiissee Change the layout of the sub-pages in the N-up printing from row-wise to columnwise. ----nnuupp--xxppaadd==_n_u_m Set the page x-padding of the _n-up printing to _n_u_m PostScript points. The default is 10 points. ----nnuupp--yyppaadd==_n_u_m Set the page y-padding of the _n-up printing to _n_u_m PostScript points. The default is 10 points. ----ppaaggee--llaabbeell--ffoorrmmaatt==_f_o_r_m_a_t Set the page label format to _f_o_r_m_a_t. The page label format specifies how the labels for the `%%Page:' PostScript comments are formatted. The possible values are: sshhoorrtt Print the current pagenumber: `%%Page: (1) 1' (default) lloonngg Print the current filename and pagenumber: `%%Page: (main.c: 1) 1' ----ppss--lleevveell==_l_e_v_e_l Set the PostScript language level that eennssccrriipptt uses for its output to _l_e_v_e_l. The possible values are 11, and 22. ----pprriinntteerr--ooppttiioonnss==_o_p_t_i_o_n_s Pass extra options to the printer command. ----rroottaattee--eevveenn--ppaaggeess Rotate each even-numbered page 180 degrees. ----sslliiccee==_n_u_m Print the vertical slice _n_u_m. The slices are ver tical regions of input files. A new slice starts from the point where the line would otherwise be wrapped to the next line. The slice numbers start from 1. ----ssttyyllee==_s_t_y_l_e Set the highlighting style to _s_t_y_l_e. The possible values are: aa22ppss, eemmaaccss, eemmaaccss--vveerrbboossee, iiffhh, and mmssvvcc. ----sswwaapp--eevveenn--ppaaggee--mmaarrggiinnss Swap left and right page margins for even-numbered pages. ----ttoocc Print a table of contents to the end of the out put. ----wwoorrdd--wwrraapp Wrap long lines from word boundaries. ----uull--aannggllee==_a_n_g_l_e Set the angle of the underlay text to _a_n_g_l_e. As a default, the angle is aattaann((--dd__ppaaggee__hh,, dd__ppaaggee__ww)). ----uull--ffoonntt==_n_a_m_e Select a font for the underlay text. The default underlay font is TTiimmeess--RRoommaann220000. ----uull--ggrraayy==_n_u_m Print the underlay text with the gray value _n_u_m (0 ... 1), the default gray value is .8. ----uull--ppoossiittiioonn==_p_o_s_i_t_i_o_n___s_p_e_c Set the underlay text's starting position accord ing to the _p_o_s_i_t_i_o_n___s_p_e_c. The position specifica tion must be given in format: `_s_i_g_n _x_p_o_s _s_i_g_n _y_p_o_s', where the _s_i_g_n must be `+' or `-'. The positive dimensions are measured from the lower left corner and the negative dimensions from the upper right corner. For example, the specifica tion `+0-0' specifies the upper left corner and `-0+0' specifies the lower right corner. ----uull--ssttyyllee==_s_t_y_l_e Set the underlay text's style to _s_t_y_l_e. The pos sible values for _s_t_y_l_e are: oouuttlliinnee print outline underlay texts (default) ffiilllleedd print filled underlay texts CCOONNFFIIGGUURRAATTIIOONN FFIILLEESS EEnnssccrriipptt reads configuration information from the follow ing sources (in this order): command line options, envi ronment variable EENNSSCCRRIIPPTT, user's personal configuration file ($$HHOOMMEE//..eennssccrriippttrrcc), site configuration file (@@SSYYSSCCOONNFFDDIIRR@@//eennssccrriippttssiittee..ccffgg) and system's global con figuration file (@@SSYYSSCCOONNFFDDIIRR@@//eennssccrriipptt..ccffgg). The configuration files have the following format: Empty lines and lines starting with `#' are comments. All other lines are option lines and have format: _o_p_t_i_o_n [_a_r_g_u_m_e_n_t_s _._._.]. The following options can be specified: AAcccceeppttCCoommppoossiitteeCChhaarraacctteerrss:: _b_o_o_l Specify whether PostScript font's composite char acters are accepted as printable or if they should be considered as non-existent. The default value is false (0). AAFFMMPPaatthh:: _p_a_t_h Specifies the search path for the _A_F_M files. AAppppeennddCCttrrllDD:: _b_o_o_l Specify if the Control-D (^D) character should be appended to the end of the output. The default value is false (0). CClleeaann77BBiitt:: _b_o_o_l Specify how characters greater than 127 are printed. The valuee true (1) generates 7-bit clean code by escaping all characters greater than 127 to the backslash-octal notation (default). The value false (0) generates 8-bit PostScript code leaving all characters untouched. DDeeffaauullttEEnnccooddiinngg:: _n_a_m_e Select the default input encoding. The encoding name _n_a_m_e can be one of the values of the option --XX, ----eennccooddiinngg. DDeeffaauullttFFaannccyyHHeeaaddeerr:: _n_a_m_e Select the default fancy header. The default header is used when the option --GG is specified or the option ----ffaannccyy--hheeaaddeerr is given without an argument. The system-wide default is `eennssccrriipptt'. DDeeffaauullttMMeeddiiaa:: _n_a_m_e Select the default output media. DDeeffaauullttOOuuttppuuttMMeetthhoodd:: _m_e_t_h_o_d Select the default target to which the generated output is sent. The possible values for the _m_e_t_h_o_d are: pprriinntteerr send output to printer (default) ssttddoouutt send output to ssttddoouutt DDoowwnnllooaaddFFoonntt:: _f_o_n_t_n_a_m_e Include the font description file of the font _f_o_n_t_n_a_m_e to the generated output. EEssccaappeeCChhaarr:: _n_u_m Specify the escape character for the special escapes. The default value is 0. FFoorrmmFFeeeeddTTyyppee:: _t_y_p_e Specify what to do when a formfeed character is encountered from the input. The possible values for _t_y_p_e are: ccoolluummnn move to the beginning of the next column (default) ppaaggee move to the beginning of the next page GGeenneerraatteePPaaggeeSSiizzee:: _b_o_o_l Specify whether the PPaaggeeSSiizzee page device setting is generated to the PostScript output. The default value is true (1). HHiigghhlliigghhttBBaarrGGrraayy:: _g_r_a_y Specify the gray level which is used to print the highlight bars. HHiigghhlliigghhttBBaarrss:: _n_u_m Specify how high the highlight bars are in lines. The default value is 0 which means that no high light bars are printed. LLiibbrraarryyPPaatthh:: _p_a_t_h Specifies the eennssccrriipptt's library path that is used to lookup various resources. The default path is: `@DATADIR@/enscript:_h_o_m_e/.enscript'. Where the _h_o_m_e is the user's home directory. MMaarrkkWWrraappppeeddLLiinneess:: _s_t_y_l_e Mark wraped lines in the output with the style _s_t_y_l_e. The possible values for the _f_o_r_m_a_t are the same which can be given for the ----mmaarrkk--wwrraappppeedd--lliinneess option. MMeeddiiaa:: _n_a_m_e _w_i_d_t_h _h_e_i_g_h_t _l_l_x _l_l_y _u_r_x _u_r_y Add a new output media with the name _n_a_m_e. The physical dimensions of the media are _w_i_d_t_h and _h_e_i_g_h_t. The bounding box of the Media is speci fied by the points (_l_l_x, _l_l_y) and (_u_r_x, _u_r_y). EEnnssccrriipptt prints all graphics inside the bounding box of the media. User can select this media with option --MM _n_a_m_e. NNooJJoobbHHeeaaddeerrSSwwiittcchh:: _s_w_i_t_c_h Specify the spooler option to suppress the print job header page. This option is passed to the printer spooler when the eennssccrriipptt's option --hh, ----nnoo--jjoobb--hheeaaddeerr is selected. NNoonnPPrriinnttaabblleeFFoorrmmaatt:: _f_o_r_m_a_t Specify how the non-printable characters are printed. The possible values for _f_o_r_m_a_t are the same which can be given for the ----nnoonn--pprriinntt aabbllee--ffoorrmmaatt option. OOuuttppuuttFFiirrssttLLiinnee:: _l_i_n_e Set the PostScript output's first line to _l_i_n_e. The default value is PPSS--AAddoobbee--33..00. Since some printers do not like DSC levels greater than 2.0, this option can be used to change the output first line to something more suitable like %%!!PPSS-- AAddoobbee--22..00 or %%!!. PPaaggeeLLaabbeellFFoorrmmaatt:: _f_o_r_m_a_t Set the page label format to _f_o_r_m_a_t. The possible values for _f_o_r_m_a_t are the same which can be given for the ----ppaaggee--llaabbeell--ffoorrmmaatt option. PPaaggeePPrreeffeeeedd:: _b_o_o_l Enable / disable page prefeed. The default value is false (0). PPoossttSSccrriippttLLeevveell:: _l_e_v_e_l Set the PostScript language level, that eennssccrriipptt uses for its output, to _l_e_v_e_l. The possible val ues for _l_e_v_e_l are the same which can be given for the ----ppss--lleevveell option. PPrriinntteerr:: _n_a_m_e Names the printer to which the output is spooled. QQuueeuueePPaarraamm:: _n_a_m_e The spooler command switch to select the printer queue, e.g. --PP in llpprr --PPppss. This option can also be used to pass other flags to the spooler com mand. These options must be given before the queue switch. SSeettPPaaggeeDDeevviiccee:: _k_e_y[::_v_a_l_u_e] Pass a page device definition to the generated PostScript output. SSppoooolleerr:: _n_a_m_e Names the printer spooler command. EEnnssccrriipptt pipes generated PostScript to the command _n_a_m_e. SSttaatteessBBiinnaarryy:: _p_a_t_h Define an absolute path to the ssttaatteess program. SSttaatteessCCoolloorr:: _b_o_o_l Should the ssttaatteess program generate color outputs. SSttaatteessCCoonnffiiggFFiillee:: _f_i_l_e Read highlighting states configuration from the file _f_i_l_e. The default config file is `@DATADIR@/enscript/hl/enscript.st'. SSttaatteessHHiigghhlliigghhttSSttyyllee:: _s_t_y_l_e Set the highlight style to _s_t_y_l_e. SSttaatteessPPaatthh:: _p_a_t_h Define the path for the ssttaatteess program. The ssttaatteess program will lookup its state definition files from this path. The default value is `$HOME/.enscript:@DATADIR@/enscript/hl'. SSttaattuussDDiicctt:: _k_e_y[::_v_a_l_u_e] Pass a statusdict definition to the generated PostScript output. TTOOCCFFoorrmmaatt:: _f_o_r_m_a_t Format table of contents entries with the format string _f_o_r_m_a_t. The format string _f_o_r_m_a_t can con tain the same escapes which are used to format header strings with the `%Format' special comment. UUnnddeerrllaayy:: _t_e_x_t Print string _t_e_x_t under every page. UUnnddeerrllaayyAAnnggllee:: _n_u_m Set the angle of the underlay text to _n_u_m. UUnnddeerrllaayyFFoonntt:: _f_o_n_t_s_p_e_c Select a font for the underlay text. UUnnddeerrllaayyGGrraayy:: _n_u_m Print the underlay text with the gray value _n_u_m. UUnnddeerrllaayyPPoossiittiioonn:: _p_o_s_i_t_i_o_n___s_p_e_c Set the underlay text's starting position accord ing to the _p_o_s_i_t_i_o_n___s_p_e_c. UUnnddeerrllaayySSttyyllee:: _s_t_y_l_e Set the underlay text's style to _s_t_y_l_e. FFAANNCCYY HHEEAADDEERRSS Users can create their own fancy headers by creating a header description file and placing it in a directory which is in eennssccrriipptt's library path. The name of the header file must be in format: `_h_e_a_d_e_r_n_a_m_e.hdr'. Header can be selected by giving option: ----ffaannccyy--hheeaaddeerr==_h_e_a_d_e_r_ _n_a_m_e. Header description file contains PostScript code that paints the header. Description file must provide proce dure ddoo__hheeaaddeerr which is called by eennssccrriipptt at the begin ning of every page. Header description file contains two parts: comments and code. Parts are separated by a line containing text: % -- code follows this line -- EEnnssccrriipptt copies only the code part of description file to the generated PostScript output. The comments part can contain any data, it is not copied. If separator line is missing, no data is copied to output. EEnnssccrriipptt defines following constants which can be used in header description files: dd__ppaaggee__ww page width dd__ppaaggee__hh page height dd__hheeaaddeerr__xx header lower left _x coordinate dd__hheeaaddeerr__yy header lower left _y coordinate dd__hheeaaddeerr__ww header width dd__hheeaaddeerr__hh header height dd__ffooootteerr__xx footer lower left _x coordinate dd__ffooootteerr__yy footer lower left _y coordinate dd__ffooootteerr__ww footer width dd__ffooootteerr__hh footer height dd__oouuttppuutt__ww width of the text output area dd__oouuttppuutt__hh height of the text output area uusseerr__hheeaaddeerr__pp predicate which tells if user has defined his/her own header string: ttrruuee/ffaallssee uusseerr__hheeaaddeerr__lleefftt__ssttrr if uusseerr__hheeaaddeerr__pp is ttrruuee, this is the left field of the user supplied header string. uusseerr__hheeaaddeerr__cceenntteerr__ssttrr if uusseerr__hheeaaddeerr__pp is ttrruuee, this is the cen ter field of the user supplied header string uusseerr__hheeaaddeerr__rriigghhtt__ssttrr if uusseerr__hheeaaddeerr__pp is ttrruuee, this is the right field of the user supplied header string uusseerr__ffooootteerr__pp predicate which tells if user has defined his/her own footer string: ttrruuee/ffaallssee uusseerr__ffooootteerr__lleefftt__ssttrr if uusseerr__ffooootteerr__pp is ttrruuee, this is the left field of the user supplied footer string. uusseerr__ffooootteerr__cceenntteerr__ssttrr if uusseerr__ffooootteerr__pp is ttrruuee, this is the cen ter field of the user supplied footer string uusseerr__ffooootteerr__rriigghhtt__ssttrr if uusseerr__ffooootteerr__pp is ttrruuee, this is the right field of the user supplied footer string HHFF standard header font (from --FF, ----hheeaaddeerr--ffoonntt option). This can be selected simply by invoking command: `HHFF sseettffoonntt'. ppaaggeennuumm the number of the current page ffnnaammee the full name of the printed file (/foo/bar.c) ffddiirr the directory part of the file name (/foo) ffttaaiill file name without the directory part (bar.c) ggss__llaanngguuaaggeelleevveell PostScript interpreter's language level (currently 1 or 2) You can also use the following special comments to cus tomize your headers and to specify some extra options. Special comments are like DSC comments but they start with a single `%' character; special comments start from the beginning of the line and they have the following syntax: %_c_o_m_m_e_n_t_n_a_m_e: _o_p_t_i_o_n_s Currently eennssccrriipptt support the following special comments: %%FFoorrmmaatt:: _n_a_m_e _f_o_r_m_a_t Define a new string constant _n_a_m_e according to the format string _f_o_r_m_a_t. Format string start from the first non-space character and it ends to the end of the line. Format string can contain gen eral `%' escapes and input file related `$' escapes. Currently following escapes are sup ported: %%%% character `%' $$$$ character `$' $$%% current page number $$== number of pages in the current file $$pp number of pages processed so far $$((_V_A_R)) value of the environment variable _V_A_R. %%cc trailing component of the current working directory %%CC ($$CC) current time (file modification time) in `hh:mm:ss' format %%dd current working directory %%DD ($$DD) current date (file modification date) in `yy-mm-dd' format %%DD{{_s_t_r_i_n_g}} ($$DD{{_s_t_r_i_n_g}}) format string _s_t_r_i_n_g with the strftime(3) function. `%%DD{{}}' refers to the current date and `$$DD{{}}' to the input file's last modification date. %%EE ($$EE) current date (file modification date) in `yy/mm/dd' format %%FF ($$FF) current date (file modification date) in `dd.mm.yyyy' format %%HH document title $$LL number of lines in the current input file. This is valid only for the toc entries, it can't be used in header strings. %%mm the hostname up to the first `.' character %%MM the full hostname %%nn the user login name $$nn input file name without the directory part %%NN the user's pw_gecos field up to the first `,' character $$NN the full input file name %%tt ($$tt) current time (file modification time) in 12-hour am/pm format %%TT ($$TT) current time (file modification time) in 24-hour format `hh:mm' %%** ($$**) current time (file modification time) in 24-hour format with seconds `hh:mm:ss' $$vv the sequence number of the current input file $$VV the sequence number of the current input file in the `Table of Contents' format: if the ----ttoocc option is given, escape expands to `_n_u_m-'; if the ----ttoocc is not given, escape expands to an empty string. %%WW ($$WW) current date (file modification date) in `mm/dd/yy' format All format directives except `$=' can also be given in format _e_s_c_a_p_e _w_i_d_t_h _d_i_r_e_c_t_i_v_e where _w_i_d_t_h specifies the width of the column to which the escape is printed. For example, escape "$5%" will expand to something like " 12". If the width is negative, the value will be printed left- justified. For example, the `emacs.hdr' defines its date string with the following format comment: %%FFoorrmmaatt:: eeuurrddaatteessttrr %%EE which expands to: //eeuurrddaatteessttrr ((9966//0011//0088)) ddeeff %%HHeeaaddeerrHHeeiigghhtt:: _h_e_i_g_h_t Allocate _h_e_i_g_h_t points space for the page header. The default header height is 36 points. %%FFooootteerrHHeeiigghhtt:: _h_e_i_g_h_t Allocate _h_e_i_g_h_t points space for the page footer. The default footer height is 0 points. According to Adobe's Document Structuring Conventions (DSC), all resources needed by a document must be listed in document's prolog. Since user's can create their own headers, eennssccrriipptt don't know what resources those headers use. That's why all headers must contain a standard DSC comment that lists all needed resources. For example, used fonts can be listed with following comment: %%DocumentNeededResources: font _f_o_n_t_n_a_m_e_1 _f_o_n_t_n_a_m_e_2 Comment can be continued to the next line with the stan dard continuation comment: %%+ font _f_o_n_t_n_a_m_e_3 SSPPEECCIIAALL EESSCCAAPPEESS EEnnssccrriipptt supports special escape sequences which can be used to add some page formatting commands to ASCII docu ments. As a default, special escapes interpretation is off, so all ASCII files print out as everyone expects. Special escapes interpretation is activated by giving option --ee, ----eessccaappeess to eennssccrriipptt. All special escapes start with the escape character. The default escape character is ^@ (octal 000); escape charac ter can be changed with option --ee, ----eessccaappeess. Escape character is followed by escape's name and optional options and arguments. Currently eennssccrriipptt supports following escapes: bbggccoolloorr change the text background color. The syntax of the escape is: ^@bgcolor{_r_e_d _g_r_e_e_n _b_l_u_e} where the color components _r_e_d, _g_r_e_e_n, and blue are given as decimal numbers between values 0 and 1. bbggggrraayy change the text background color. The syntax of the escape is: ^@bggray{_g_r_a_y} where _g_r_a_y is the new text background gray value. The default value is 1.0 (white). ccoolloorr change the text color. The syntax of the escape is: ^@color{_r_e_d _g_r_e_e_n _b_l_u_e} where color components _r_e_d, _g_r_e_e_n and _b_l_u_e are given as decimal numbers between values 0 and 1. ccoommmmeenntt comment the rest of the line including the newline character. Escape's syntax is: ^@comment _t_e_x_t _n_e_w_l_i_n_e___c_h_a_r_a_c_t_e_r eessccaappee change the escape character. The syntax of the escape is: ^@escape{_c_o_d_e} where _c_o_d_e is the decimal code of the new escape character. eeppssff inline EPS file to the document. The syntax of the escape is: ^@epsf[_o_p_t_i_o_n_s]{_f_i_l_e_n_a_m_e} where _o_p_t_i_o_n_s is an optional sequence of option characters and values enclosed with brackets and _f_i_l_e_n_a_m_e is the name of the EPS file. If _f_i_l_e_n_a_m_e ends to the `|' character, then _f_i_l_e_ _n_a_m_e is assumed to name a command that prints EPS data to its standard output. In this case, eennssccrriipptt opens a pipe to the specified command and reads EPS data from pipe. Following options can be given for the eeppssff escape: cc print image centered rr print image right justified nn do not update current point. Following output is printed to that position where the current point was just before the eeppssff escape nnxx do not update current point _x coordinate nnyy do not update current point _y coordinate xx_n_u_m move image's top left _x coordinate _n_u_m characters from current point _x coordinate (relative position) xx_n_u_maa set image's top left _x coordinate to col umn _n_u_m (absolute position) yy_n_u_m move image's top left _y coordinate _n_u_m lines from current line (relative posi tion) yy_n_u_maa set image's top left _y coordinate to line _n_u_m (absolute position) hh_n_u_m set image's height to _n_u_m lines ss_n_u_m scale image with factor _n_u_m ssxx_n_u_m scale image in _x direction with factor _n_u_m ssyy_n_u_m scale image in _y direction with factor _n_u_m As a default, all dimensions are given in lines (vertical) and characters (horizontal). You can also specify other units by appending an unit specifier after number. Possible unit specifiers and the corresponding units are: cc centimeters ii inches ll lines or characters (default) pp PostScript points For example to print an image one inch high, you can specify height by following options: hh11ii (1 inch), hh22..5544cc (2.54 cm), hh7722pp (72 points). ffoonntt select current font. The syntax of the escape is: ^@font{_f_o_n_t_n_a_m_e[:_e_n_c_o_d_i_n_g]} where _f_o_n_t_n_a_m_e is a standard font specification. Special font specification ddeeffaauulltt can be used to select the default body font (eennssccrriipptt's default or the one specified by the command line option --ff, ----ffoonntt). The optional argument _e_n_c_o_d_i_n_g specifies the encoding that should be used for the new font. Currently the encoding can only be the eennssccrriipptt's global input encoding or ppss. llooaaddxx load the current point X-coordinate from a regis ter. The syntax of the escape is: ^@loadx{_r_e_g_i_s_t_e_r} ppss include raw PostScript code to the output. The syntax of the escape is: ^@ps{_c_o_d_e} ssaavveexx save the current point X-coordinate into a regis ter. The position can later be restored with the llooaaddxx escape. The syntax of the escape is: ^@savex{_r_e_g_i_s_t_e_r} sshhaaddee highlight regions of text by changing the text background color. Escape's syntax is: ^@shade{_g_r_a_y} where _g_r_a_y is the new text background gray value. The default value is 1.0 (white) which disables highlighting. PPAAGGEE DDEEVVIICCEE OOPPTTIIOONNSS Page device is a PostScript level 2 feature that offers an uniform interface to control printer's output device. EEnnssccrriipptt protects all page device options inside an if block so they have no effect in level 1 interpreters. Although all level 2 interpreters support page device, they do not have to support all page device options. For example some printers can print in duplex mode and some can not. Refer to the documentation of your printer for supported options. Here are some usable page device options which can be selected with the --DD, ----sseettppaaggeeddeevviiccee option. For a com plete listing, see _P_o_s_t_S_c_r_i_p_t _L_a_n_g_u_a_g_e _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l: section 4.11 Device Setup. CCoollllaattee _b_o_o_l_e_a_n how output is organized when printing multiple copies DDuupplleexx _b_o_o_l_e_a_n duplex (two side) printing MMaannuuaallFFeeeedd _b_o_o_l_e_a_n manual feed paper tray OOuuttppuuttFFaacceeUUpp _b_o_o_l_e_a_n print output `face up' or `face down' TTuummbbllee _b_o_o_l_e_a_n how opposite sides are positioned in duplex print ing PPRRIINNTTIINNGG EEXXAAMMPPLLEESS Following printing examples assume that eennssccrriipptt uses the default configuration. If default actions have been changed from the configuration files, some examples will behave differently. eennssccrriipptt ffoooo..ttxxtt Print file ffoooo..ttxxtt to the default printer. eennssccrriipptt --PPoossssuu ffoooo..ttxxtt Print file ffoooo..ttxxtt to printer oossssuu. eennssccrriipptt --ppffoooo..ppss ffoooo..ttxxtt Print file ffoooo..ttxxtt, but leave PostScript output to file ffoooo..ppss. eennssccrriipptt --22 ffoooo..ttxxtt Print file ffoooo..ttxxtt to two columns. eennssccrriipptt --22rr ffoooo..ttxxtt Print file to two columns and rotate output 90 degrees (landscape). eennssccrriipptt --DDDDuupplleexx::ttrruuee ffoooo..ttxxtt Print file in duplex (two side) mode (printer dependant). eennssccrriipptt --GG22rrEE --UU22 ffoooo..cc My default code printing command: gaudy header, two columns, landscape, code highlighting, 2-up printing. eennssccrriipptt --EE ----ccoolloorr --wwhhttmmll ----ttoocc --ppffoooo..hhttmmll **..hh **..cc A nice HTML report of your project's C source files. EENNVVIIRROONNMMEENNTT VVAARRIIAABBLLEESS The environment variable EENNSSCCRRIIPPTT can be used to pass default options for eennssccrriipptt. For example, to select the default body font to be Times-Roman 7pt, set the following value to the EENNSSCCRRIIPPTT environment variable: --ffTTiimmeess--RRoommaann77 The value of the EENNSSCCRRIIPPTT variable is processed before the command line options, so command line options can be used to overwrite these defaults. Variable EENNSSCCRRIIPPTT__LLIIBBRRAARRYY specifies the eennssccrriipptt's library directory. It can be used to overwrite the build-in default `@DATADIR@/enscript'. RREETTUURRNN VVAALLUUEE EEnnssccrriipptt returns value 1 to the shell if any errors were encountered or 0 otherwise. If the option ----eexxtteennddeedd--rreettuurrnn--vvaalluueess was specified, the return value is constructed from the following flags: 00 no errors or warnings 22 some lines were truncated or wrapped 44 some characters were missing from the used fonts 88 some characters were unprintable FFIILLEESS @DATADIR@/enscript/*.hdr header files @DATADIR@/enscript/*.enc input encoding vectors @DATADIR@/enscript/enscript.pro PostScript prolog @DATADIR@/enscript/afm/*.afm AFM files for PostScript fonts @DATADIR@/enscript/font.map index for the AFM files @DATADIR@/enscript/hl/*.st states definition files @SYSCONFDIR@/enscript.cfg system-wide configuration file @SYSCONFDIR@/enscriptsite.cfg site configuration file ~/.enscriptrc personal configuration file ~/.enscript/ personal resource directory SSEEEE AALLSSOO diffpp(1), ghostview(1), gs(1), lpq(1), lpr(1), lprm(1), states(1) AAUUTTHHOORR Markku Rossi <mtr@iki.fi> <http://www.iki.fi/~mtr/> GNU Enscript WWW home page: <http://www.iki.fi/~mtr/gen script/> ENSCRIPT Mar 12, 1999 ENSCRIPT(1)